Stories Table
Describes the stories table in supabase. This page is helpful in understanding the story editor.
See Test Stories for examples.
| Column | type | Description |
| ------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| name | string | Name of the story. This name appears as the title of the story in story menu view |
| description | string | A quick description of the story. This can be seen only by the admin inside of story editor. |
| previous | string | ID of the the story which must be completed to unlock this story. |
| stages | array: stage | An array of stages that will play in the order they are placed inside of this array. More detail on each stage below. (See What are stories for brief descriptions on each stage.) | |
| index | number | Used to order stories in the final application. The index indicates the position of the story in an array of stories rendered in the final application. |
Audio Slide Stage "audio-slide"
Shows multiple buttons, asks user to press the buttons to hear sounds. Each button has a sound associated with its picture.
| Property | type | Description |
|---|---|---|
type | string | The type of stage. Always "audio-slide" |
frame | Frame | See Frame for more detail. |
Frame
An image-audio pair which shows the image and plays the sound at the same time in the following stages:
| Property | type | Description |
|---|---|---|
audio | string | UUID of the audio file stored in the file editor. See Uploading assets for more detail. |
image | string | UUID of the image file stored in the file editor. See Uploading assets for more detail. |
Audio Button Stage "audio-button"
Plays a pre-defined sound file which contains an instruction. (e.g. "éist leis na focail seo".)
| Property | type | Description |
|---|---|---|
type | string | The type of stage. Always "audio-slide". |
frames | array: Frame | An array storing audio buttons in the order in which they are displayed. See Frame for more detail. |
Audio Button Activity Stage "audio-button-activity"
Shows multiple buttons, and plays the sound of the button that should be clicked. The user should press the correct button to proceed to the next stage.
| Property | type | Description |
|---|---|---|
type | string | The type of stage. Always "audio-button-activity". |
frames | array: Frame | An array storing audio buttons in the order in which they are displayed. See Frame for more detail. |
correct_frame | integer | The index of the frame that will render a button which is required to press to complete the activity. |
Audio Drag Activity Stage "audio-drag-activity"
Shows multiple images, and plays the sound of the image that should be dragged into the box. The user should drag the correct image to proceed to the next stage.
| Property | type | Description |
|---|---|---|
type | string | The type of stage. Always "audio-drag-activity". |
frames | array: Frame | An array storing audio buttons in the order in which they are displayed. See Frame for more detail. |
correct_frame | integer | The index of the frame that will render an image which is required to drag into the drag box to complete the activity. |
Song Stage "song"
Shows a sound player with play/pause and repeat buttons. Plays the song from the beginning. When the song has finished playing unlocks the ability to proceed to the next stage.
| Peoperty | type | Description |
|---|---|---|
type | string | The type of stage. Always "song". |
audio | string | UUID of the audio file stored in the file editor. See Uploading assets for more detail. |
Song Activity Stage "song-activity"
Shows a sound player red dividers at which the song will pause. When the song pauses a screen opens prompting the user for voice input. If the input is correct the user proceeds to the next stage of the song if it is incorrect the user should repeat the section.
| Peoperty | type | Description |
|---|---|---|
type | string | The type of stage. Always "song-activity". |
audio | string | UUID of the audio file stored in the file editor. See Uploading assets for more detail. |
sequence | array: Timestamp | Array of timestamps where the song should pause and ask user for voice input. Each timestamp must be inserted in ascending order! (See Timestamp for more information.) |
Timestamp
Used in Song Activity Stage to indicate when the song should be paused, how long it should be paused for and what is the correct answer to proceed to the next Timestamp.
| Peoperty | type | Description |
|---|---|---|
answer | string | A text string with the value of the missing word in the song which the user is expected to say in order to proceed. |
speak_time | integer | Time in milliseconds that the user is given to give an answer by speaking into the device. |
timestamp_ms | integer | Time in milliseconds that specifies the point in the song at which the song should be paused. |